Add documentation to the macrocache module
#17431
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
konsumlamm
reviewed
Mar 21, 2021
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
ghost
marked this pull request as ready for review
ringabout
pushed a commit
to ringabout/Nim
that referenced
this pull request
Mar 22, 2021
* Add docs to macrocache * use hint * Use incl in the incl example * add macrocache to lib * consistency * Update doc/lib.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * apply suggestions * clarify the warning Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
ardek66
pushed a commit
to ardek66/Nim
that referenced
this pull request
Mar 26, 2021
* Add docs to macrocache * use hint * Use incl in the incl example * add macrocache to lib * consistency * Update doc/lib.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * apply suggestions * clarify the warning Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The old wording was unclear, also there were no code examples.
One thing which I'm still not sure of is how we can show the usage in different modules.
Create a code block example with multiple files, or is the text enough?
Also, I had to name caches of the same type differently because
runnableExamplescompiles them from a single file so that their content will be shared if they have the same name.Closes #14889